United Public Domain Gold 2/United Public Domain Gold 2.iso/utilities/pu314.dms/pu314.adf/ReadMail/ReadMail.doc

Text File | 1990-01-19 | 17KB | 410 lines

 ______   _____   _____   ____    _    _   _____   _   _
|  __  | |  ___| |  _  | |  _ \  | \  / | |  _  | | | | |
| |__| | | |__   | |_| | | | | | |  \/  | | |_| | | | | |
|  _  _| |  __|  |  _  | | | | | | |\/| | |  _  | | | | |
| | \ \  | |___  | | | | | |_| | | |  | | | | | | | | | |__
|_|  \_\ |_____| |_| |_| |____/  |_|  |_| |_| |_| |_| |____|

============================================================


        DESCRIPTION
        -----------
Amiga  ReadMail  is a tool for use with NComm V1.8 or later,
made  by Torkel Lodberg.  ReadMail lets you read, answer and
enter  MBBS messages offline, using input from the keyboard.
Some  file functions are also implemented.  ReadMail creates
a  NComm  script  that uploads all the messages to the board
and  grabs  new  messages.   Information  about new files is
also collected.

It  uses  the  grabfile  created  by the MBBS bulletin board
system   as   input.   Before  using  ReadMail,  you  should
therefore  collect  grabfiles from the different systems you
want  to  use it with.  It will accept a blank file as well,
but the name *must* be correct.

First,   create  the  directory  where  you  want  to  place
ReadMail, or use the path "NComm:" if the device where it is
lying  has enough space for the different files.  Then, make
subdirectories  for  the  different  boards.  Place the GRAB
files within these directories.


        FILES CREATED
        -------------
All  files generated will be placed in the same directory as
the grabfile is situated.  Here is a list of files that will
be  generated.   <filename> equals the name of the grabfile,
and 'n' is a number generated by ReadMail, starting at zero.
It  increases by one for each message written.  It is highly
important  that  you  don't  change the name of the grabfile
after  having  performed  a  GRAB since the filename also is
used in the script to unarc the grabfile after grabbing, and
then to start ReadMail.

<filename>.script    -  scriptfile
<filename>.exe       -  'execute' file used by script
<filename>n          -  message(s)
<filename>.keep      -  messages added with 'keep' command
<filename>.newfiles  -  new files since last logon

* Script assumes that
* 1. You are using ENGLISH commands
* 2. You have set up to use the SCREEN editor
* 3. You have turned on automatic file transfer
* 4. You have PKAX in the C: directory
* 5. You have a smart enough modem to report offhook
* 6. You are using IBN translation


        STARTING UP
        -----------
ReadMail has the following synopsis:

ReadMail [-s] [filename]

As  you  can  see, an optional filename may be appended as a
parameter,  as  well  as  the  option  '-s'  if  you want to
reconfigure the ReadMail setup.  The filename is relative to
the current directory.  The brackets should of course not be
included.   They  just  mean  that  this  is optional.  From
workbench, just click on the icon.

ReadMail  first  looks for some important information in the
file   NComm:NComm.config.   If  this  file  doesn't  exist,
ReadMail  won't  work,  so  be  sure  to  save  the  correct
configuration  in  NComm  before using ReadMail.  The colors
configured in NComm's 2 colour mode will be used.

If  no  filename  is  entered,  a  File Input Requester will
appear in the center of the screen.  For instructions on how
to  use  this, see the "File Input Requester" below.  Select
the  FULL  directory  and  name of the grabfile, so that the
script later can find it.

If the file "ReadMail.config" and "NComm:ReadMail.config" (a
special setup file used by ReadMail only) don't exist, or if
the  parameter  '-s'  is  appended,  a  window that contains
different gadgets will appear.

In  the string gadget marked 'User', enter the name you have
registered with on the current board.  It is used to log you
in.

In  the string gadget marked 'Editor', enter the name of the
editor  you  want  to  use  with ReadMail.  It must accept a
filename as parameter.  Please note that programs that start
their  own  process can not be used due to problems with the
Amiga  operating  system.   However, there is one exception.
The "ED" command that follows with CygnusED Professional may
be  used as long there is a copy of CygnusED already running
when  called  from ReadMail.  This is also a handy solution,
since  the  editor is only loaded once.  Go and buy CygnusED
folks!   I.e.  start up CygnusED Professional *before* using
ReadMail  and  place  the  ProCED  'Ed'  command  in the 'C'
directory.  A few hints to persons who don't have ProCED and
don't  have a harddisk:  Make your editors resident or place
them on the ram disk for faster loading.

In  the string gadget marked 'Readmaildir', specify the FULL
directory  where  ReadMail  is situated.  It will be used to
start ReadMail after grabbing.

If  the  specified editor uses the WorkBench screen, turn on
the  'WB  to  front'  option.   This  will pop the workbench
screen to front when the editor is started, and will pop the
ReadMail screen to front when finished editing.

If  you  want  to configure this scriptfile with an entry in
NComm's  phonebook, turn the 'PB execute' option on.  If you
turn  this option on, remember to also include your password
in the phonebook.

If  you  don't want ReadMail to hang up when it has finished
its  job  on  the BBS, turn the 'Interactive session' option
on.  ReadMail will then wait for the hangup string before it
unarc's the GRAB file and starts ReadMail.

Press  the  'OK'  gadget to go on, however, be careful.  The
current  script  (if  any)  will  be  discarded so press the
'Cancel'  gadget to regret.  Press the 'Save' gadget to save
the  current  configuration.  The information will be stored
in  a file called 'ReadMail.config' if the file exists, else
it will be stored as 'NComm:ReadMail.config'.

If  you  have configured 'PB Execute' off, a window will pop
up.   Here,  enter the phonenumber to the current board, and
the  password  you use at this board.  Press 'Return' in the
password gadget to go on.


        USING THE COMMANDS
        ------------------
You  may  now read through the messages.  Press the HELP key
for a full list of commands.  The commands are mostly 'Less'
or  'More'  compatible.  Here is a description of how to use
the different commands.


'NEXT MSG' prompt:

Press  'E'  to  enter  a  new message.  This will bring up a
requester  containing  three  string gadgets.  In the gadget
marked  'Conference',  enter the full name of the conference
you  want  the  message  placed  in.   In  the gadget marked
'Receiver',  enter  the  name of the person you want to send
the  message  to, or press 'ENTER' for 'ALL'.  In the gadget
marked  'Subject', enter the subject of the current message.
If  the  'Conference' or 'Receiver' field is left blank, the
function  will be aborted.  Else, the editor will be started
and  the  workbench  will  pop  to front if specified in the
configuration  file.   The  textfile 'ReadMail.sign' will be
added to the message if it exists in the ReadMail directory.
Go on with editing the message and then save it.

Press  'R'  to  reply the current message.  A requester will
pop  up  and  ask  if you want the current message included.
Press  'Cancel' to abort the function.  If you answer 'Yes',
the  message will first be written to disk.  The editor will
be  started and the workbench will pop to front if specified
in  the  configuration  file.   The textfile 'ReadMail.sign'
will  be  added  to the message if it exists in the ReadMail
directory.  Go on with editing the message and then save it.
The next message will be displayed by ReadMail.

Press  'I' to import a message from disk.  This function was
specially  designed for persons who don't have enough RAM to
run  ReadMail and their favourite editor simultaneosly.  The
messages must be written before starting ReadMail and should
could  be called <filename>n, where 'n' is the number of the
message.   They  must be placed in the same directory as the
grabfile.   The function will bring up a requester that asks
if  the  message  should  be a reply to the current message.
Select  'Cancel'  to  abort  the function.  If the answer is
negative,  a  window that contains three string gadgets will
pop  up.   In the gadget marked 'Conference', enter the full
name  of  the conference you want the message placed in.  In
the  gadget  marked 'Receiver', enter the name of the person
you want to send the message to, or press 'ENTER' for 'ALL'.
In  the  gadget  marked  'Subject', enter the subject of the
current  message.   If  answer  to  the  first  requester is
positive,  the  next  message will be displayed by ReadMail.
The textfile 'ReadMail.sign' will be added to the message if
it exists in the ReadMail directory.

Press  'P' to make a hardcopy of the message on the printer.
The message 'Printing' will be displayed while in progress.

Press  'K'  to  store  the message for later retrieval.  The
message will be added to a file called <filename>.keep.

Press  'A'  to  append the message to a specific file.  This
function  works  like  the 'keep' command, but will bring up
the  file  requester.   Select  or  enter  a  filename.  The
message  will  be  added  to  the file.  If the file doesn't
exist, it will be created.

Press  'T'  or  '<'  to  display  the  first  message in the
grabfile.

Press  'BACKSPACE'  or  'Cursor  Left' to move backwards one
message.

Press 'B' to move backwards one page.

Press  'CTRL-L',  'Cursor  Up' or 'C' to display the current
message from the beginning.

Press 'H' to only display the header of the next message.

Press 'SPACE', 'ENTER', 'Cursor Right' or 'F' to display the
next message in the grabfile.

Press 'S' to display the next message without stopping, i.e.
without displaying the 'More' prompt.

Press  '>'  or  'L'  to display the highest message you have
read in the grabfile.

Press  from  '1' to '0' on the keyboard to position from 10%
to 100% in the file.  I.e.  '0' will position you at the end
of the file.

Press 'M' to move to the next conference.

Press 'D' to download a file from the system.  This will pop
up  a  window  that  contains a string gadget marked 'Name'.
Enter  the  name of the file you want to download.  The file
will be placed in the G&R download directory.  If the gadget
is left empty, the function will be aborted.

Press  'U' to upload a file to the system.  This will pop up
a  window  that  contains two string gadgets.  In the gadget
marked  'Name',  enter  the  name  of  the  file you want to
upload.   The  file  must  rely in the G&R upload directory.
Enter  a  description  of  the  file  in  the  gadget marked
'Description'.   If  one  of  the gadgets is left empty, the
function will be aborted.  A requester will pop up that asks
whether  the  file  should  be  private  or not.  A positive
answer  will bring up a new requester that asks who the file
should  be  private for.  Enter the full name of the person.
If the file should be kept private to a conference, remember
to first join the conference before using this function.

Press  'J'  to  join  a  new conference.  This will pop up a
window  that  contains a string gadget marked 'Name'.  Enter
the  full  name  of the conference.  Leave the name blank to
abort.

Press 'X' to resign from a conference.  A window will pop up
that contains a string gadget marked 'Name'.  Enter the full
name  of  the conference you want to resign from.  Leave the
name blank to abort.

Press  '/'  to  search for a string.  The bottom line of the
window will be made active.  Enter the string to search for,
or  leave  the line blank to abort.  The message 'Searching'
will  be  displayed  at  the  same line.  The search is case
insensitive.   If the string is not found, the final message
in the grabfile will be displayed.

Press  'N'  to  search for the next occurence of the string.
The search is case insensitive.  If the string is not found,
the final message in the grabfile will be displayed.

Press  'G'  to  display  the  file  named <filename>.keep on
screen.   It  contains  the  messaged  added with the 'Keep'
command.

Press  'V'  to display the file named <filename>.newfiles on
screen.   This  file  contains  a  list  of new files and is
collected for each logon.

Press 'Q' or 'CTRL-C' when finished answering messages.  The
function  will  ask  for a confirm, since the script will be
discarded  the  next  time  you  start ReadMail if you leave
Readmail  by  mistake.  This will create the script and quit
the  program.



'NEXT MSG' prompt:

Press 'ENTER' to display the next line of the message.

Press 'SPACE', 'Cursor Down' or 'F' to display the next page
of the message.

Press  'S'  to  display  the  rest  of  the  message without
stopping, i.e.  without displaying the 'More' prompt.

Press some other key to abort to 'Next Msg' prompt.


Note;  If  the message 'EDITOR ERROR' appears on screen, the
editor could not be loaded.  This means that the editor name
specified   at   startup   is  uncorrect,  or  the  commands
'Execute', 'Cd' and 'C:Run' are not available.

Also  note; The 'Yes/No/Cancel' requester can be answered by
pressing 'Y', 'N' and 'C' respectively.

The  prompts contain a calculated percentage relative to the
current file position.


        THE FILE INPUT REQUESTER
        ------------------------
Many  functions  call  upon  a  file  name.   The file input
requester then appears on the screen with a sorted directory
listing of the current directory in the window.

At the bottom of the requester, eight devices are displayed.
To  change the current device, click in one of these boxes -
the  device  must  be  available  on  your  system  (i.e not
ghosted) for you to chose it.

To   enter  a  directory,  position  the  pointer  over  the
directory name and click once or enter the directory name in
the 'Directory' string gadget.

The  'PARENT' gadget will move you back one directory - i.e.
this  will  cause  the  parent directory to be displayed, if
such a directory exists.

You  may  select  a filename by positioning the pointer over
it.   Open  the file by doubleclicking, or by first clicking
on   the   filename  and  afterwards  on  the  'OK'  gadget.
Alternatively,  type  the  name  of  the desired file in the
requester marked 'File' and press Return.

In  the  'Type'  string gadget, enter an optional extension.
This  will  display  only  the  files with that suffix.  For
example, entering ".TXT" will display only the textfiles.

The  window only has room for 10 entries.  To scroll through
the directory, use the dragbar.

The  number  of  bytes  free  on  the current device will be
displayed in the middle of the two gadgets.  Always check if
there   is   enough  space  on  the  current  device  before
downloading files.

The 'Directory' string gadget will be active when the window
opens.  Pressing Return will move the cursor directly to the
'File' gadget.  This can be handy if you don't want to mouse
around.

Use  the  upper  right depth-arrangers to move the window in
front or in back of other windows.

Selecting 'CANCEL' will abort the operation.

Note:
When the file requester is on screen (active), you can still
send  and receive data.  Sorting and displaying the files on
a  disk  takes  some  time;  you  may  want  to bring up the
requester  early,  and continue talking to the remote system
while this is being done.


        SPECIAL REQUIREMENTS
        --------------------
None,  but  a harddisk is heavily recommended if you want to
use  this  program  with  more  than one board.  The program
works  with  both  NTSC  and  PAL.

        VERSION
        -------
2.0 / 17-Jun-89.  Comments, suggestions and bug reports are
welcome!

Original   idea   taken  from  IBM  ReadMail  made  by  Mike
Robertson.   The  file  requester  is based on the requester
from C.  Heath.  Thanks!  Thanks also go to Daniel Bloch and
Trym  Hansen  for  their help, and to Michael Farion for his
icon.   Doc  icon  from the Swilling collection, courtesy of
Frank Swilling (Minotaur).

Contact me on my BBS, international: [phone]
                      national: [phone]

     ...or by mail to Torkel Lodberg
                      Pilotveien 10
                      N-0384 OSLO 3
                      NORWAY

This program is Shareware - you are not allowed to sell this
program,  and  you  may  only  copy  it  for  non-commercial
purposes!

This program represents over hundred hours of hard work.  If
you  find this program useful, you really ought to send some
sort  of  a  contribution to my address.  Examples of such a
contribution is 20$ or some disks containing the hottest and
newest  public domain or shareware programs, for my BBS.  If
I receive any contributions, they will probably make me want
to make many more programs!